home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 151-175 / disk_162 / flow2troff / flow2troff.doc < prev    next >
Text File  |  1992-05-06  |  4KB  |  131 lines
  1.  
  2. **************************************************************************
  3. * Flow2Troff:    Convert from New Horizons Software "FLOW" files to
  4. *        UNIX "troff" files, suitable for printing on any
  5. *        troff-compatible laser printer.
  6. *
  7. * Author:    Daniel Barrett    (barrett@cs.jhu.edu)
  8. *        Department of Computer Science
  9. *        The Johns Hopkins University
  10. *        Baltimore, MD  21218
  11. *
  12. * Status:    Flow2Troff and Flow2Troff.c are in the PUBLIC DOMAIN.
  13. *        So is getopt.h, by "aklevin", to the best of my knowledge.
  14. *
  15. * Current version of Flow2Troff is 1.0.
  16. **************************************************************************
  17.  
  18. CONTENTS
  19. --------
  20.  
  21.     How to invoke Flow2Troff
  22.     Detailed description of the options
  23.     Printing the final product
  24.     Playing with bold, italics & underline styles
  25.     Compiling Flow2Troff
  26.  
  27.  
  28. How to invoke Flow2Troff
  29. ------------------------
  30.  
  31. If you just type "Flow2Troff", you'll get the following message:
  32.  
  33. Usage:        Flow2Troff [options] Flow_file [Troff_file]
  34.  
  35. Options:    -p#    : Set troff point size (default 12)
  36.         -v#    : Set troff vertical spacing (default 13)
  37.         -i#    : Set indentation (default 3)
  38.         -d#    : Print only to specified depth (default all)
  39.         -h    : Permit hyphenation (default is none)
  40.         -t    : Title the outline with "Flow_file"
  41.  
  42. Notes:
  43.     [options] refers to one or more of the listed options.
  44.     "Flow_File" is the Flow file used as input to the program.
  45.     "Troff_file" is the output file, containing troff code.
  46.  
  47.     If not specified, Troff_file is written on standard output.
  48.  
  49.  
  50. Detailed description of the options
  51. -----------------------------------
  52.  
  53.     Options may be given separately or combined, and in any order.  For
  54. options with arguments (all options except -h), you may separate the option
  55. from its argument by a space, if you want.
  56.  
  57. The following two sets of options are exactly equivalent:
  58.  
  59.     Flow2Troff -p18 -d3 -h Flow_file
  60.  
  61.     Flow2Troff -hd3 -p 18 Flow_file
  62.  
  63.     Here is a brief chart of what Flow2Troff's options do.  It
  64. helps if you know troff, but you can still use the program without that
  65. knowledge.
  66.  
  67. Option        Troff Equivalent    Explanation
  68. -------------------------------------------------------------------------
  69. -p#, -p #    .ps #            Set your point size; how tall do
  70.                     you want your characters?
  71. -v#, -v #    .vs #            Vertical spacing; how much space
  72.                     between lines of text?
  73. -i#, -i #    .in +#            How many spaces is considered
  74.                     one "indent"?
  75. -d#, -d #    <none>            Print the outline only to the
  76.                     specified depth.  Try it a few
  77.                     times and you'll see what it
  78.                     does.
  79. -h        (removes        Allow long words to be separated by
  80.         ".nh")            a hyphen at the end of a line.
  81.                     Default: no hyphenation allowed.
  82. -t        .ce 1
  83.         .ft B            Give your outline a title.
  84.         Flow_file        The title is the name of the
  85.         .ft R            input Flow file.
  86.  
  87.  
  88. Playing with bold, italics, & underline styles
  89. ----------------------------------------------
  90.  
  91.     Flow allows you to have simultaneous bold, italics, and underline
  92. styles.  Troff allows either bold or italics, not both, and has no
  93. built-in ability for underlining.  Flow2Troff has to obey the limits of
  94. troff, by definition.
  95.     In Flow2Troff, you can have bold, italics, bold + underline, 
  96. italics + underline, or plain.  If you Flow_file has a heading with
  97. both bold and italics, then bold takes precedence.
  98.     Underlining is a real hack, but I don't know a better way
  99. to do it in Troff.
  100.  
  101.  
  102. Printing the Final Product
  103. --------------------------
  104.  
  105. (1)    Use FLOW to create an outline.  Save in "normal" file format.
  106. (2)    Flow2Troff [options] Flow_file Troff_file.
  107. (3)    Transfer Troff_file to a UNIX machine.
  108. (4)    On a UNIX system, print Troff_file with the program "troff".
  109.     Exact syntax varies from system to system.  You might want
  110.     to use the "-me" macro package (or similar) to introduce
  111.     page breaks; Flow2Troff DOES NOT CALCULATE PAGE BREAKS FOR YOU.
  112.  
  113. Compiling Flow2Troff
  114. --------------------
  115.  
  116.     Flow2Troff compiles & runs on both Amiga and 4.2BSD UNIX
  117. systems.  (I haven't tested it on other UNIX systems, but I see no
  118. reason that Flow2Troff wouldn't work.)
  119.  
  120. AMIGA:    I use MANX C V3.6.  To compile, use the supplied Makefile,
  121.     or type:
  122.  
  123.             cc Flow2Troff.c
  124.             ln Flow2Troff.o -lc
  125.  
  126.     I would guess that Flow2Troff compiles fine under Lattice C also.
  127.  
  128. UNIX:    Use the supplied Makefile.unix, or type:
  129.  
  130.             cc -DUNIX Flow2Troff.c -o Flow2Troff
  131.